Kanzi 4.0.0-beta2
kanzi::gfx::DrawCommand Struct Reference

Issues a draw command in a render pipeline. More...

#include <kanzi/gfx/commands.hpp>

Inheritance diagram for kanzi::gfx::DrawCommand:
[legend]

Public Member Functions

 DrawCommand ()
 Constructor.
 
- Public Member Functions inherited from kanzi::gfx::BaseCommand
uint32_t getSize () const
 Gets the command size in bytes.
 
uint8_t getTag () const
 Gets the command tag.
 
CommandType getType () const
 Gets the command type.
 
void setTag (uint8_t tag)
 Sets the command tag.
 

Public Attributes

uint32_t elementCount
 The number of indices or vertices to draw.
 
uint32_t indexOffset
 The index offset within the index buffer.
 
uint32_t instanceCount
 The instance count.
 
uint32_t instanceOffset
 The instance offset.
 
uint32_t vertexOffset
 The vertex offset.
 

Additional Inherited Members

- Protected Member Functions inherited from kanzi::gfx::BaseCommand
 BaseCommand (CommandType t, uint32_t s)
 Constructor.
 
 BaseCommand (const BaseCommand &other)
 Copy Constructor.
 
BaseCommandoperator= (const BaseCommand &other)
 Assignment operator.
 

Detailed Description

Issues a draw command in a render pipeline.

Since
Kanzi 4.0.0

Constructor & Destructor Documentation

◆ DrawCommand()

kanzi::gfx::DrawCommand::DrawCommand ( )
inline

Constructor.

Member Data Documentation

◆ elementCount

uint32_t kanzi::gfx::DrawCommand::elementCount

The number of indices or vertices to draw.

◆ indexOffset

uint32_t kanzi::gfx::DrawCommand::indexOffset

The index offset within the index buffer.

◆ instanceCount

uint32_t kanzi::gfx::DrawCommand::instanceCount

The instance count.

◆ instanceOffset

uint32_t kanzi::gfx::DrawCommand::instanceOffset

The instance offset.

◆ vertexOffset

uint32_t kanzi::gfx::DrawCommand::vertexOffset

The vertex offset.


The documentation for this struct was generated from the following file: